<?php
/**
 * Cache_Interface
 * @filesource
 */
/**
 * Namespace
 */
namespace framework\library\interfaces;
/**
 * Dependencies
 */
/**
 * A file based cache implementation
 * 
 * @author Randy Casburn <randy@plurious.com>
 * @copyright Copyright Plurious Software, all rights reserved
 * @license MIT
 * @license http://www.opensource.org/licenses/mit-license.html
 * @link http://plurious.com/framework/documentation/classes/Front.html
 * @version 2.1
 * @api
 */
interface Cache_Interface {

    /**
     * Clear out old/stale cache files
     */
    public function freshen();

    /**
     * Retrieve cached data based up on a key lookup
     * 
     * @param string $key magic number used for cache identity
     * @return string the cache content  
     */
    public function get($key);

    /**
     * Store data in the cache 
     * 
     * Store as key with content being value
     * 
     * @param string $key
     * @param string $value 
     */
    public function set($key, $value);

    /**
     * Remove cached data by removing the file holding the cache
     * 
     * @param string $key 
     */
    public function delete($key);

    /**
     * Clear all cached data
     */
    public function clear() ;
}

?>